docs(readme): fix non-existent @/ path alias in theming code example#191
Open
andrerfneves wants to merge 1 commit into
Open
docs(readme): fix non-existent @/ path alias in theming code example#191andrerfneves wants to merge 1 commit into
andrerfneves wants to merge 1 commit into
Conversation
The README Theming section showed `import { ThemeProvider } from '@/components/theme-provider'`
but the project does not configure a `@` path alias in vite.config.js. The actual codebase
uses relative imports (`./components/theme-provider`).
A user copying the example would encounter import errors. This fixes the example to use
the correct relative import path that matches the project's actual usage.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the README Theming section's code example which referenced a non-existent
@path alias.Why
The README showed:
But the project does not configure an
@path alias invite.config.js— noresolve.aliasis set. The actual codebase uses relative imports everywhere, e.g../components/theme-provider.A user copying the example verbatim would encounter import errors. The code example also contradicts the actual import style used throughout the project.
Changes
README.md: Changedimport { ThemeProvider } from '@/components/theme-provider'toimport { ThemeProvider } from './components/theme-provider'Test Plan